home *** CD-ROM | disk | FTP | other *** search
/ Danny Amor's Online Library / Danny Amor's Online Library - Volume 1.iso / html / faqs / faq / lisp-faq / part3 < prev    next >
Encoding:
Text File  |  1995-07-25  |  35.5 KB  |  796 lines

  1. Subject: FAQ: Lisp Frequently Asked Questions 3/7 [Monthly posting]
  2. Newsgroups: comp.lang.lisp,news.answers,comp.answers
  3. From: mkant+@cs.cmu.edu (Mark Kantrowitz)
  4. Date: 13 Nov 1994 08:01:13 GMT
  5.  
  6. Archive-name: lisp-faq/part3
  7. Last-Modified: Tue Sep 13 18:05:47 1994 by Mark Kantrowitz
  8. Version: 1.50
  9. Maintainer: Mark Kantrowitz and Barry Margolin <ai+lisp-faq@cs.cmu.edu>
  10. URL: http://www.cs.cmu.edu:8001/Web/Groups/AI/html/faqs/lang/lisp/top.html
  11. Size: 36400 bytes, 797 lines
  12.  
  13. ;;; ****************************************************************
  14. ;;; Answers to Frequently Asked Questions about Lisp ***************
  15. ;;; ****************************************************************
  16. ;;; Written by Mark Kantrowitz and Barry Margolin
  17. ;;; lisp_3.faq
  18.  
  19. This post contains Part 3 of the Lisp FAQ.
  20.  
  21. If you think of questions that are appropriate for this FAQ, or would
  22. like to improve an answer, please send email to us at ai+lisp-faq@cs.cmu.edu.
  23.  
  24. This section contains a list of common pitfalls. Pitfalls are aspects
  25. of Common Lisp which are non-obvious to new programmers and often
  26. seasoned programmers as well.
  27.  
  28. Common Pitfalls (Part 3):
  29.  
  30.   [3-0]  Why does (READ-FROM-STRING "foobar" :START 3) return FOOBAR
  31.          instead of BAR?  
  32.   [3-1]  Why can't it deduce from (READ-FROM-STRING "foobar" :START 3)
  33.          that the intent is to specify the START keyword parameter
  34.          rather than the EOF-ERROR-P and EOF-VALUE optional parameters?   
  35.   [3-2]  Why can't I apply #'AND and #'OR?
  36.   [3-3]  I used a destructive function (e.g. DELETE, SORT), but it
  37.          didn't seem to work.  Why? 
  38.   [3-4]  After I NREVERSE a list, it's only one element long.  After I
  39.          SORT a list, it's missing things.  What happened? 
  40.   [3-5]  Why does (READ-LINE) return "" immediately instead of waiting
  41.          for me to type a line?  
  42.   [3-6]  I typed a form to the read-eval-print loop, but nothing happened. Why?
  43.   [3-7]  DEFMACRO doesn't seem to work.
  44.          When I compile my file, LISP warns me that my macros are undefined
  45.          functions, or complains "Attempt to call <function> which is 
  46.          defined as a macro.
  47.   [3-8]  Name conflict errors are driving me crazy! (EXPORT, packages)
  48.   [3-9]  Closures don't seem to work properly when referring to the
  49.          iteration variable in DOLIST, DOTIMES, DO and LOOP.
  50.   [3-10] What is the difference between FUNCALL and APPLY?
  51.   [3-11] Miscellaneous things to consider when debugging code.
  52.   [3-12] When is it right to use EVAL?
  53.   [3-13] Why does my program's behavior change each time I use it?
  54.   [3-14] When producing formatted output in Lisp, where should you put the
  55.          newlines (e.g., before or after the line, FRESH-LINE vs TERPRI,
  56.          ~& vs ~% in FORMAT)?
  57.   [3-15] I'm using DO to do some iteration, but it doesn't terminate. 
  58.   [3-16] My program works when interpreted but not when compiled!
  59.  
  60. Search for \[#\] to get to question number # quickly.
  61.  
  62. ----------------------------------------------------------------
  63. Subject: [3-0] Why does (READ-FROM-STRING "foobar" :START 3) return FOOBAR 
  64.                instead of BAR?
  65.  
  66. READ-FROM-STRING is one of the rare functions that takes both &OPTIONAL and
  67. &KEY arguments:
  68.  
  69.        READ-FROM-STRING string &OPTIONAL eof-error-p eof-value 
  70.                                &KEY :start :end :preserve-whitespace
  71.  
  72. When a function takes both types of arguments, all the optional
  73. arguments must be specified explicitly before any of the keyword
  74. arguments may be specified.  In the example above, :START becomes the
  75. value of the optional EOF-ERROR-P parameter and 3 is the value of the
  76. optional EOF-VALUE parameter.
  77.      
  78. To get the desired result, you should use
  79.    (READ-FROM-STRING "foobar" t nil :START 3)
  80. If you need to understand and use the optional arguments, please refer
  81. to CLTL2 under READ-FROM-STRING, otherwise, this will behave as
  82. desired for most purposes.
  83.  
  84. ----------------------------------------------------------------
  85. Subject: [3-1] Why can't it deduce from (READ-FROM-STRING "foobar" :START 3) 
  86.       that the intent is to specify the START keyword parameter rather than
  87.       the EOF-ERROR-P and EOF-VALUE optional parameters?
  88.  
  89. In Common Lisp, keyword symbols are first-class data objects.  Therefore,
  90. they are perfectly valid values for optional parameters to functions.
  91. There are only four functions in Common Lisp that have both optional and
  92. keyword parameters (they are PARSE-NAMESTRING, READ-FROM-STRING,
  93. WRITE-LINE, and WRITE-STRING), so it's probably not worth adding a
  94. nonorthogonal kludge to the language just to make these functions slightly
  95. less confusing; unfortunately, it's also not worth an incompatible change
  96. to the language to redefine those functions to use only keyword arguments.
  97.      
  98. ----------------------------------------------------------------
  99. Subject: [3-2] Why can't I apply #'AND and #'OR?
  100.  
  101. Here's the simple, but not necessarily satisfying, answer: AND and OR are
  102. macros, not functions; APPLY and FUNCALL can only be used to invoke
  103. functions, not macros and special operators.
  104.  
  105. OK, so what's the *real* reason?  The reason that AND and OR are macros
  106. rather than functions is because they implement control structure in
  107. addition to computing a boolean value.  They evaluate their subforms
  108. sequentially from left/top to right/bottom, and stop evaluating subforms as
  109. soon as the result can be determined (in the case of AND, as soon as a
  110. subform returns NIL; in the case of OR, as soon as one returns non-NIL);
  111. this is referred to as "short circuiting" in computer language parlance.
  112. APPLY and FUNCALL, however, are ordinary functions; therefore, their
  113. arguments are evaluated automatically, before they are called.  Thus, were
  114. APPLY able to be used with #'AND, the short-circuiting would be defeated.
  115.  
  116. Perhaps you don't really care about the short-circuiting, and simply want
  117. the functional, boolean interpretation.  While this may be a reasonable
  118. interpretation of trying to apply AND or OR, it doesn't generalize to other
  119. macros well, so there's no obvious way to have the Lisp system "do the
  120. right thing" when trying to apply macros.  The only function associated
  121. with a macro is its expander function; this function accepts and returns
  122. and form, so it cannot be used to compute the value.
  123.  
  124. The Common Lisp functions EVERY and SOME can be used to get the
  125. functionality you intend when trying to apply #'AND and #'OR.  For
  126. instance, the erroneous form:
  127.  
  128.    (apply #'and *list*)
  129.  
  130. can be translated to the correct form:
  131.  
  132.    (every #'identity *list*)
  133.  
  134. ----------------------------------------------------------------
  135. Subject: [3-3] I used a destructive function (e.g. DELETE, SORT), but 
  136.                it didn't seem to work.  Why?
  137.  
  138. I assume you mean that it didn't seem to modify the original list.  There
  139. are several possible reasons for this.  First, many destructive functions
  140. are not *required* to modify their input argument, merely *allowed* to; in
  141. some cases, the implementation may determine that it is more efficient to
  142. construct a new result than to modify the original (this may happen in Lisp
  143. systems that use "CDR coding", where RPLACD may have to turn a CDR-NEXT or
  144. CDR-NIL cell into a CDR-NORMAL cell), or the implementor may simply not
  145. have gotten around to implementing the destructive version in a truly
  146. destructive manner.  Another possibility is that the nature of the change
  147. that was made involves removing elements from the front of a list; in this
  148. case, the function can simply return the appropriate tail of the list,
  149. without actually modifying the list. And example of this is:
  150.      
  151.    (setq *a* (list 3 2 1))
  152.    (delete 3 *a*) => (2 1)
  153.    *a* => (3 2 1)
  154.  
  155. Similarly, when one sorts a list, SORT may destructively rearrange the
  156. pointers (cons cells) that make up the list. SORT then returns the cons
  157. cell that now heads the list; the original cons cell could be anywhere in
  158. the list. The value of any variable that contained the original head of the
  159. list hasn't changed, but the contents of that cons cell have changed
  160. because SORT is a destructive function:
  161.  
  162.    (setq *a* (list 2 1 3))
  163.    (sort *a* #'<) => (1 2 3)
  164.    *a* => (2 3)     
  165.  
  166. In both cases, the remedy is the same: store the result of the
  167. function back into the place whence the original value came, e.g.
  168.  
  169.    (setq *a* (delete 3 *a*))
  170.    *a* => (2 1)
  171.  
  172. Why don't the destructive functions do this automatically?  Recall
  173. that they are just ordinary functions, and all Lisp functions are
  174. called by value. They see the value of the argument, not the argument
  175. itself. Therefore, these functions do not know where the lists they
  176. are given came from; they are simply passed the cons cell that
  177. represents the head of the list. Their only obligation is to return
  178. the new cons cell that represents the head of the list. Thus
  179. "destructive" just means that the function may munge the list by
  180. modifying the pointers in the cars and cdrs of the list's cons cells.
  181. This can be more efficient, if one doesn't care whether the original
  182. list gets trashed or not.
  183.  
  184. One thing to be careful about when doing this (storing the result back
  185. into the original location) is that the original list might be
  186. referenced from multiple places, and all of these places may need to
  187. be updated.  For instance:
  188.  
  189.    (setq *a* (list 3 2 1))
  190.    (setq *b* *a*)
  191.    (setq *a* (delete 3 *a*))
  192.    *a* => (2 1)
  193.    *b* => (3 2 1) ; *B* doesn't "see" the change
  194.    (setq *a* (delete 1 *a*))
  195.    *a* => (2)
  196.    *b* => (3 2) ; *B* sees the change this time, though
  197.  
  198. One may argue that destructive functions could do what you expect by
  199. rearranging the CARs of the list, shifting things up if the first element
  200. is being deleted, as they are likely to do if the argument is a vector
  201. rather than a list.  In many cases they could do this, although it would
  202. clearly be slower.  However, there is one case where this is not possible:
  203. when the argument or value is NIL, and the value or argument, respectively,
  204. is not.  It's not possible to transform the object referenced from the
  205. original cell from one data type to another, so the result must be stored
  206. back.  Here are some examples:
  207.  
  208.    (setq *a* (list 3 2 1))
  209.    (delete-if #'numberp *a) => NIL
  210.    *a* => (3 2 1)
  211.    (setq *a* nil *b* '(1 2 3))
  212.    (nconc *a* *b*) => (1 2 3)
  213.    *a* => NIL
  214.  
  215. The names of most destructure functions (except for sort, delete,
  216. rplaca, rplacd, and setf of accessor functions) have the prefix N.
  217.  
  218. In summary, the two common problems to watch out for when using
  219. destructive functions are:
  220.  
  221.    1. Forgetting to store the result back. Even though the list
  222.       is modified in place, it is still necessary to store the
  223.       result of the function back into the original location, e.g.,
  224.            (setq foo (delete 'x foo))
  225.  
  226.       If the original list was stored in multiple places, you may
  227.       need to store it back in all of them, e.g.
  228.            (setq bar foo)
  229.            ...
  230.            (setq foo (delete 'x foo))
  231.            (setq bar foo)
  232.  
  233.    2. Sharing structure that gets modified. If it is important
  234.       to preserve the shared structure, then you should either
  235.       use a nondestructive operation or copy the structure first
  236.       using COPY-LIST or COPY-TREE.
  237.            (setq bar (cdr foo))
  238.            ...
  239.            (setq foo (sort foo #'<))
  240.            ;;; now it's not safe to use BAR
  241.  
  242. Note that even nondestructive functions, such as REMOVE, and UNION,
  243. can return a result which shares structure with an argument. 
  244. Nondestructive functions don't necessarily copy their arguments; they
  245. just don't modify them.
  246.      
  247. ----------------------------------------------------------------
  248. Subject: [3-4] After I NREVERSE a list, it's only one element long.  
  249.                After I SORT a list, it's missing things.  What happened?
  250.  
  251. These are particular cases of the previous question.  Many NREVERSE and
  252. SORT implementations operate by rechaining all the CDR links in the list's
  253. backbone, rather than by replacing the CARs.  In the case of NREVERSE, this
  254. means that the cons cell that was originally first in the list becomes the
  255. last one.  As in the last question, the solution is to store the result
  256. back into the original location.
  257.      
  258. ----------------------------------------------------------------
  259. Subject: [3-5] Why does (READ-LINE) return "" immediately instead of 
  260.                waiting for me to type a line?
  261.  
  262. Many Lisp implementations on line-buffered systems do not discard the
  263. newline that the user must type after the last right parenthesis in order
  264. for the line to be transmitted from the OS to Lisp.  Lisp's READ function
  265. returns immediately after seeing the matching ")" in the stream.  When
  266. READLINE is called, it sees the next character in the stream, which is a
  267. newline, so it returns an empty line.  If you were to type "(read-line)This
  268. is a test" the result would be "This is a test".
  269.  
  270. The simplest solution is to use (PROGN (CLEAR-INPUT) (READ-LINE)).  This
  271. discards the buffered newline before reading the input.  However, it would
  272. also discard any other buffered input, as in the "This is a test" example
  273. above; some implementation also flush the OS's input buffers, so typeahead
  274. might be thrown away.
  275.  
  276. ----------------------------------------------------------------
  277. Subject: [3-6] I typed a form to the read-eval-print loop, but 
  278.                nothing happened. Why?
  279.  
  280. There's not much to go on here, but a common reason is that you haven't
  281. actually typed a complete form.  You may have typed a doublequote, vertical
  282. bar, "#|" comment beginning, or left parenthesis that you never matched
  283. with another doublequote, vertical bar, "|#", or right parenthesis,
  284. respectively.  Try typing a few right parentheses followed by Return.
  285.  
  286. ----------------------------------------------------------------
  287. Subject: [3-7]  DEFMACRO doesn't seem to work. 
  288.                 When I compile my file, LISP warns me that my macros
  289.                 are undefined functions, or complains 
  290.                   "Attempt to call <function> which is defined as a macro."
  291.  
  292. When you evaluate a DEFMACRO form or proclaim a function INLINE, it
  293. doesn't go back and update code that was compiled under the old
  294. definition. When redefining a macro, be sure to recompile any
  295. functions that use the macro. Also be sure that the macros used in a
  296. file are defined before any forms in the same file that use them.
  297.  
  298. Certain forms, including LOAD, SET-MACRO-CHARACTER, and
  299. REQUIRE, are not normally evaluated at compile time. Common Lisp
  300. requires that macros defined in a file be used when compiling later
  301. forms in the file. If a Lisp doesn't follow the standard, it may be
  302. necessary to wrap an EVAL-WHEN form around the macro definition.
  303.  
  304. Most often the "macro was previously called as a function" problem
  305. occurs when files were compiled/loaded in the wrong order. For
  306. example, developers may add the definition to one file, but use it in
  307. a file which is compiled/loaded before the definition. To work around
  308. this problem, one can either fix the modularization of the system, or
  309. manually recompile the files containing the forward references to macros.
  310.  
  311. Also, if your macro calls functions at macroexpand time, those functions
  312. may need to be in an EVAL-WHEN. For example,
  313.  
  314.     (defun some-function (x)
  315.       x)
  316.  
  317.     (defmacro some-macro (y)
  318.       (let ((z (some-function y)))
  319.         `(print ',z)))
  320.  
  321. If the macros are defined in a file you require, make sure your
  322. require or load statement is in an appropriate EVAL-WHEN. Many people
  323. avoid all this nonsense by making sure to load all their files before
  324. compiling them, or use a system facility (or just a script file) that
  325. loads each file before compiling the next file in the system.
  326.  
  327. ----------------------------------------------------------------
  328. Subject: [3-8]  Name conflict errors are driving me crazy! (EXPORT, packages)
  329.  
  330. If a package tries to export a symbol that's already defined, it will
  331. report an error. You probably tried to use a function only to discover
  332. that you'd forgotten to load its file. The failed attempt at using the
  333. function caused its symbol to be interned. So now, when you try to
  334. load the file, you get a conflict. Unfortunately, understanding and
  335. correcting the code which caused the export problem doesn't make those
  336. nasty error messages go away. That symbol is still interned where it
  337. shouldn't be. Use unintern to remove the symbol from a package before
  338. reloading the file. Also, when giving arguments to REQUIRE or package
  339. functions, use strings or keywords, not symbols: (find-package "FOO"),
  340. (find-package :foo). 
  341.  
  342. A sometimes useful technique is to rename (or delete) a package
  343. that is "too messed up".  Then you can reload the relevant files
  344. into a "clean" package.
  345.  
  346. ----------------------------------------------------------------
  347. Subject: [3-9]  Closures don't seem to work properly when referring to the
  348.                 iteration variable in DOLIST, DOTIMES, DO and LOOP.
  349.  
  350. DOTIMES, DOLIST, DO and LOOP all use assignment instead of binding to
  351. update the value of the iteration variables. So something like
  352.    
  353.    (let ((l nil))
  354.      (dotimes (n 10)
  355.        (push #'(lambda () n)
  356.          l)))
  357.  
  358. will produce 10 closures over the same value of the variable N. To
  359. avoid this problem, you'll need to create a new binding after each
  360. assignment: 
  361.  
  362.    (let ((l nil))
  363.      (dotimes (n 10)
  364.     (let ((n n))
  365.       (push #'(lambda () n)
  366.         l))))
  367.  
  368. Then each closure will be over a new binding of n.
  369.  
  370. This is one reason why programmers who use closures prefer MAPC and
  371. MAPCAR to DOLIST.
  372.  
  373. ----------------------------------------------------------------
  374. Subject: [3-10] What is the difference between FUNCALL and APPLY?
  375.  
  376. FUNCALL is useful when the programmer knows the length of the argument
  377. list, but the function to call is either computed or provided as a
  378. parameter.  For instance, a simple implementation of MEMBER-IF (with
  379. none of the fancy options) could be written as:
  380.  
  381. (defun member-if (predicate list)
  382.   (do ((tail list (cdr tail)))
  383.       ((null tail))
  384.    (when (funcall predicate (car tail))
  385.      (return-from member-if tail))))
  386.  
  387. The programmer is invoking a caller-supplied function with a known
  388. argument list.
  389.  
  390. APPLY is needed when the argument list itself is supplied or computed.
  391. Its last argument must be a list, and the elements of this list become
  392. individual arguments to the function.  This frequently occurs when a
  393. function takes keyword options that will be passed on to some other
  394. function, perhaps with application-specific defaults inserted.  For
  395. instance:
  396.  
  397. (defun open-for-output (pathname &rest open-options)
  398.   (apply #'open pathname :direction :output open-options))
  399.  
  400. FUNCALL could actually have been defined using APPLY:
  401.  
  402. (defun funcall (function &rest arguments)
  403.   (apply function arguments))
  404.  
  405. ----------------------------------------------------------------
  406. Subject: [3-11] Miscellaneous things to consider when debugging code.
  407.  
  408. This question lists a variety of problems to watch out for when
  409. debugging code. This is sort of a catch-all question for problems too
  410. small to merit a question of their own. See also question [1-3] for
  411. some other common problems.
  412.  
  413. Functions:
  414.  
  415.   * (flet ((f ...)) (eq #'f #'f)) can return false.
  416.  
  417.   * The function LIST-LENGTH is not a faster, list-specific version
  418.     of the sequence function LENGTH.  It is list-specific, but it's
  419.     slower than LENGTH because it can handle circular lists.
  420.  
  421.   * Don't confuse the use of LISTP and CONSP. CONSP tests for the
  422.     presence of a cons cell, but will return NIL when called on NIL.
  423.     LISTP could be defined as (defun listp (x) (or (null x) (consp x))).
  424.  
  425.   * Use the right test for equality: 
  426.         EQ      tests if the objects are identical -- numbers with the
  427.                 same value need not be EQ, nor are two similar lists
  428.                 necessarily EQ. Similarly for characters and strings.
  429.                 For instance, (let ((x 1)) (eq x x)) is not guaranteed
  430.                 to return T.
  431.         EQL     Like EQ, but is also true if the arguments are numbers
  432.                 of the same type with the same value or character objects
  433.                 representing the same character. (eql -0.0 0.0) is not
  434.                 guaranteed to return T.
  435.         EQUAL   Tests if the arguments are structurally isomorphic, using
  436.                 EQUAL to compare components that are conses, bit-vectors, 
  437.                 strings or pathnames, and EQ for all other data objects
  438.                 (except for numbers and characters, which are compared
  439.                 using EQL). Except for strings and bit-vectors, arrays
  440.                 are EQUAL only if they are EQ.
  441.         EQUALP  Like EQUAL, but ignores type differences when comparing 
  442.                 numbers and case differences when comparing characters.
  443.         =       Compares the values of two numbers even if they are of
  444.                 different types.
  445.         CHAR=   Case-sensitive comparison of characters.
  446.         CHAR-EQUAL      Case-insensitive comparison of characters.
  447.         STRING= Compares two strings, checking if they are identical.
  448.                 It is case sensitive.
  449.         STRING-EQUAL  Like STRING=, but case-insensitive.
  450.  
  451.   * Some destructive functions that you think would modify CDRs might
  452.     modify CARs instead.  (E.g., NREVERSE.)
  453.  
  454.   * READ-FROM-STRING has some optional arguments before the
  455.     keyword parameters.  If you want to supply some keyword
  456.     arguments, you have to give all of the optional ones too.
  457.  
  458.   * If you use the function READ-FROM-STRING, you should probably bind
  459.     *READ-EVAL* to NIL. Otherwise an unscrupulous user could cause a
  460.     lot of damage by entering 
  461.         #.(shell "cd; rm -R *")
  462.     at a prompt.
  463.  
  464.   * Only functional objects can be funcalled in CLtL2, so a lambda
  465.     expression '(lambda (..) ..) is no longer suitable. Use
  466.     #'(lambda (..) ..) instead. If you must use '(lambda (..) ..),
  467.     coerce it to type FUNCTION first using COERCE.
  468.  
  469. Methods:
  470.  
  471.   * PRINT-OBJECT methods can make good code look buggy. If there is a
  472.     problem with the PRINT-OBJECT methods for one of your classes, it
  473.     could make it seem as though there were a problem with the object.
  474.     It can be very annoying to go chasing through your code looking for
  475.     the cause of the wrong value, when the culprit is just a bad
  476.     PRINT-OBJECT method.
  477.  
  478. Initialization:
  479.  
  480.   * Don't count on array elements being initialized to NIL, if you don't
  481.     specify an :initial-element argument to MAKE-ARRAY. For example,
  482.          (make-array 10) => #(0 0 0 0 0 0 0 0 0 0)
  483.  
  484. Iteration vs closures:
  485.  
  486.   * DO and DO* update the iteration variables by assignment; DOLIST and
  487.     DOTIMES are allowed to use assignment (rather than a new binding).
  488.     (All CLtL1 says of DOLIST and DOTIMES is that the variable "is
  489.     bound" which has been taken as _not_ implying that there will be
  490.     separate bindings for each iteration.) 
  491.  
  492.     Consequently, if you make closures over an iteration variable
  493.     in separate iterations they may nonetheless be closures over
  494.     the same variable and hence will all refer to the same value
  495.     -- whatever value the variable was given last.  For example,
  496.         (let ((fns '()))
  497.           (do ((x '(1 2) (cdr x)))
  498.               ((null x))
  499.             (push #'(lambda () x)
  500.                   fns))
  501.           (mapcar #'funcall (reverse fns)))
  502.     returns (nil nil), not (1 2), not even (2 2). Thus 
  503.          (let ((l nil)) 
  504.            (dolist (a '(1 2 3) l) 
  505.              (push #'(lambda () a)
  506.                    l)))
  507.     returns a list of three closures closed over the same bindings, whereas
  508.          (mapcar #'(lambda (a) #'(lambda () a)) '(1 2 3))
  509.     returns a list of closures over distinct bindings.
  510.  
  511. Defining Variables and Constants:
  512.  
  513.   * (defvar var init) assigns to the variable only if it does not
  514.     already have a value.  So if you edit a DEFVAR in a file and
  515.     reload the file only to find that the value has not changed,
  516.     this is the reason.  (Use DEFPARAMETER if you want the value
  517.     to change upon reloading.) DEFVAR is used to declare a variable
  518.     that is changed by the program; DEFPARAMETER is used to declare
  519.     a variable that is normally constant, but which can be changed
  520.     to change the functioning of a program.
  521.  
  522.   * DEFCONSTANT has several potentially unexpected properties:
  523.  
  524.      - Once a name has been declared constant, it cannot be used a
  525.        the name of a local variable (lexical or special) or function
  526.        parameter.  Really.  See page 87 of CLtL2.
  527.  
  528.      - A DEFCONSTANT cannot be re-evaluated (eg, by reloading the
  529.        file in which it appears) unless the new value is EQL to the
  530.        old one.  Strictly speaking, even that may not be allowed.
  531.        (DEFCONSTANT is "like DEFPARAMETER" and hence does an
  532.        assignment, which is not allowed if the name has already
  533.        been declared constant by DEFCONSTANT.)
  534.  
  535.        Note that this makes it difficult to use anything other
  536.        than numbers, symbols, and characters as constants.       
  537.  
  538.      - When compiling (DEFCONSTANT name form) in a file, the form
  539.        may be evaluated at compile-time, load-time, or both.  
  540.  
  541.        (You might think it would be evaluated at compile-time and
  542.        the _value_ used to obtain the object at load-time, but it
  543.        doesn't have to work that way.)
  544.  
  545. Declarations:
  546.  
  547.   * You often have to declare the result type to get the most
  548.     efficient arithmetic.  Eg, 
  549.  
  550.        (the fixnum (+ (the fixnum e1) (the fixnum e2)))
  551.  
  552.      rather than
  553.  
  554.        (+ (the fixnum e1) (the fixnum e2))
  555.  
  556.   * Declaring the iteration variable of a DOTIMES to have type FIXNUM
  557.     does not guarantee that fixnum arithmetic will be used.  That is,
  558.     implementations that use fixnum-specific arithmetic in the presence
  559.     of appropriate declaration may not think _this_ declaration is
  560.     sufficient.  It may help to declare that the limit is also a
  561.     fixnum, or you may have to write out the loop as a DO and add
  562.     appropriate declarations for each operation involved.
  563.  
  564. FORMAT related errors:
  565.  
  566.   * When printing messages about files, filenames like foo~ (a GNU-Emacs
  567.     backup file) may cause problems with poorly coded FORMAT control
  568.     strings.
  569.  
  570.   * Beware of using an ordinary string as the format string,
  571.     i.e., (format t string), rather than (format t "~A" string).
  572.  
  573.   * FORMAT returns NIL, so if you added a format statement at the end
  574.     of a function for debugging purposes, and that function normally
  575.     returns a value to the caller, you may have changed the behavior
  576.     of your program.
  577.  
  578. Miscellaneous:
  579.  
  580.   * Be careful of circular lists and shared list structure. 
  581.  
  582.   * Watch out for macro redefinitions.
  583.  
  584.   * A NOTINLINE may be needed if you want SETF of SYMBOL-FUNCTION to
  585.     affect calls within a file.  (See CLtL2, page 686.)
  586.  
  587.   * When dividing two numbers, beware of creating a rational number where
  588.     you intended to get an integer or floating point number. Use TRUNCATE
  589.     or ROUND to get an integer and FLOAT to ensure a floating point
  590.     number. This is a major source of errors when porting ZetaLisp or C
  591.     code to Common Lisp.
  592.  
  593.   * If your code doesn't work because all the symbols are mysteriously
  594.     in the keyword package, one of your comments has a colon (:) in
  595.     it instead of a semicolon (;).
  596.  
  597.   * If you redefine a function while in the debugger, the redefinition
  598.     may not take effect immediately. This will happen, for example,
  599.     when the execution stack is halted near the invocation of the function.
  600.     The function pointer on the stack will still be pointing to the
  601.     old definition. Go up the stack a few levels before restarting to
  602.     avoid reusing the old definition.
  603.  
  604. ----------------------------------------------------------------
  605. Subject: [3-12] When is it right to use EVAL?
  606.  
  607. Hardly ever.  Any time you think you need to use EVAL, think hard about it.
  608. EVAL is useful when implementing a facility that provides an external
  609. interface to the Lisp interpreter.  For instance, many Lisp-based editors
  610. provide a command that prompts for a form and displays its value.
  611. Inexperienced macro writers often assume that they must explicitly EVAL the
  612. subforms that are supposed to be evaluated, but this is not so; the correct
  613. way to write such a macro is to have it expand into another form that has
  614. these subforms in places that will be evaluated by the normal evaluation
  615. rules.  Explicit use of EVAL in a macro is likely to result in one of two
  616. problems: the dreaded "double evaluation" problem, which may not show up
  617. during testing if the values of the expressions are self-evaluating
  618. constants (such as numbers); or evaluation at compile time rather than
  619. runtime.  For instance, if Lisp didn't have IF and one desired to write it,
  620. the following would be wrong:
  621.  
  622.    (defmacro if (test then-form &optional else-form)
  623.      ;; this evaluates all the subforms at compile time, and at runtime
  624.      ;; evaluates the results again.
  625.      `(cond (,(eval test) ,(eval then-form))
  626.             (t ,(eval else-form))))
  627.  
  628.    (defmacro if (test then-form &optional else-form)
  629.      ;; this double-evaluates at run time
  630.      `(cond ((eval ,test) (eval ,then-form))
  631.             (t (eval ,else-form)))
  632.  
  633. This is correct:
  634.  
  635.    (defmacro if (test then-form &optional else-form)
  636.      `(cond (,test ,then-form)
  637.             (t ,else-form)))
  638.  
  639. The following question (taken from an actual post) is typical of the
  640. kind of question asked by a programmer who is misusing EVAL:
  641.  
  642.    I would like to be able to quote all the atoms except the first in a
  643.    list of atoms.  The purpose is to allow a function to be read in and
  644.    evaluated as if its arguments had been quoted.
  645.  
  646. This is the wrong approach to solving the problem. Instead, he should
  647. APPLY the CAR of the form to the CDR of the form. Then quoting the
  648. rest of the form is unnecessary. But one wonders why he's trying to
  649. solve this problem in the first place, since the toplevel REP loop
  650. already involves a call to EVAL. One gets the feeling that if we knew
  651. more about what he's trying to accomplish, we'd be able to point out a
  652. more appropriate solution that uses neither EVAL nor APPLY.
  653.  
  654. On the other hand, EVAL can sometimes be necessary when the only portable
  655. interface to an operation is a macro. 
  656.  
  657. ----------------------------------------------------------------
  658. Subject: [3-13] Why does my program's behavior change each time I use it?
  659.  
  660. Most likely your program is altering itself, and the most common way this
  661. may happen is by performing destructive operations on embedded constant
  662. data structures.  For instance, consider the following:
  663.  
  664.    (defun one-to-ten-except (n)
  665.      (delete n '(1 2 3 4 5 6 7 8 9 10)))
  666.    (one-to-ten-except 3) => (1 2 4 5 6 7 8 9 10)
  667.    (one-to-ten-except 5) => (1 2 4 6 7 8 9 10) ; 3 is missing
  668.  
  669. The basic problem is that QUOTE returns its argument, *not* a copy of
  670. it. The list is actually a part of the lambda expression that is in
  671. ONE-TO-TEN-EXCEPT's function cell, and any modifications to it (e.g., by
  672. DELETE) are modifications to the actual object in the function definition.
  673. The next time that the function is called, this modified list is used.
  674.  
  675. In some implementations calling ONE-TO-TEN-EXCEPT may even result in
  676. the signalling of an error or the complete aborting of the Lisp process.  Some
  677. Lisp implementations put self-evaluating and quoted constants onto memory
  678. pages that are marked read-only, in order to catch bugs such as this.
  679. Details of this behavior may vary even within an implementation,
  680. depending on whether the code is interpreted or compiled (perhaps due to
  681. inlined DEFCONSTANT objects or constant folding optimizations).
  682.  
  683. All of these behaviors are allowed by the draft ANSI Common Lisp
  684. specification, which specifically states that the consequences of modifying
  685. a constant are undefined (X3J13 vote CONSTANT-MODIFICATION:DISALLOW).
  686.  
  687. To avoid these problems, use LIST to introduce a list, not QUOTE. QUOTE
  688. should be used only when the list is intended to be a constant which
  689. will not be modified.  If QUOTE is used to introduce a list which will
  690. later be modified, use COPY-LIST to provide a fresh copy.
  691.  
  692. For example, the following should all work correctly:
  693.  
  694.    o  (remove 4 (list 1 2 3 4 1 3 4 5))
  695.    o  (remove 4 '(1 2 3 4 1 3 4 5))   ;; Remove is non-destructive.
  696.    o  (delete 4 (list 1 2 3 4 1 3 4 5))
  697.    o  (let ((x (list 1 2 4 1 3 4 5)))
  698.         (delete 4 x))
  699.    o  (defvar *foo* '(1 2 3 4 1 3 4 5))
  700.       (delete 4 (copy-list *foo*))
  701.       (remove 4 *foo*)
  702.       (let ((x (copy-list *foo*)))
  703.          (delete 4 x))
  704.  
  705. The following, however, may not work as expected:
  706.  
  707.    o  (delete 4 '(1 2 3 4 1 3 4 5))
  708.  
  709. Note that similar issues may also apply to hard-coded strings. If you
  710. want to modify elements of a string, create the string with MAKE-STRING.
  711.  
  712. ----------------------------------------------------------------
  713. Subject: [3-14]  When producing formatted output in Lisp, where should you 
  714.         put the newlines (e.g., before or after the line, FRESH-LINE vs TERPRI,
  715.         ~& vs ~% in FORMAT)?
  716.  
  717.  
  718. Where possible, it is desirable to write functions that produce output
  719. as building blocks. In contrast with other languages, which either
  720. conservatively force a newline at various times or require the program
  721. to keep track of whether it needs to force a newline, the Lisp I/O
  722. system keeps track of whether the most recently printed character was
  723. a newline or not. The function FRESH-LINE outputs a newline only if
  724. the stream is not already at the beginning of a line.  TERPRI forces a
  725. newline irrespective of the current state of the stream. These
  726. correspond to the ~& and ~% FORMAT directives, respectively. (If the
  727. Lisp I/O system can't determine whether it's physically at the
  728. beginning of a line, it assumes that a newline is needed, just in case.)
  729.  
  730. Thus, if you want formatted output to be on a line of its own, start
  731. it with ~& and end it with ~%. (Some people will use a ~& also at the
  732. end, but this isn't necessary, since we know a priori that we're not
  733. at the beginning of a line. The only exception is when ~& follows a
  734. ~A, to prevent a double newline when the argument to the ~A is a
  735. formatted string with a newline at the end.) For example, the
  736. following routine prints the elements of a list, N elements per line,
  737. and then prints the total number of elements on a new line:
  738.  
  739.    (defun print-list (list &optional (elements-per-line 10))
  740.      (fresh-line)
  741.      (loop for i upfrom 1
  742.            for element in list do
  743.        (format t "~A ~:[~;~%~]" element (zerop (mod i elements-per-line))))
  744.      (format t "~&~D~%" (length list)))
  745.  
  746. ----------------------------------------------------------------
  747. Subject: [3-15] I'm using DO to do some iteration, but it doesn't terminate. 
  748.  
  749. Your code probably looks something like
  750.    (do ((sublist list (cdr list))
  751.         ..)
  752.        ((endp sublist)
  753.         ..)
  754.      ..)
  755. or maybe
  756.    (do ((index start (+ start 2))
  757.         ..)
  758.        ((= index end)
  759.         ..)
  760.      ..)
  761.  
  762. The problem is caused by the (cdr list) and the (+ start 2) in the
  763. first line. You're using the original list and start index instead of
  764. the working sublist or index. Change them to (cdr sublist) and 
  765. (+ index 2) and your code should start working.
  766.  
  767. ----------------------------------------------------------------
  768. Subject: [3-16] My program works when interpreted but not when compiled!
  769.  
  770. Look for problems with your macro definitions, such as a macro that is
  771. missing a quote. When compiled, this definition essentially becomes a
  772. constant. But when interpreted, the body of the macro is executed each
  773. time the macro is called.
  774.  
  775. For example, in Allegro CL the following code will behave differently
  776. when interpreted and compiled:
  777.   (defvar x 10)
  778.   (defmacro foo () (incf x))
  779.   (defun bar () (+ (foo) (foo)))
  780. Putting a quote before the (incf x) in the definition of foo fixes the
  781. problem. 
  782.  
  783. If you use (SETF (SYMBOL-FUNCTION 'foo) ...) to change the definition
  784. of a built-in Lisp function named FOO, be aware that this may not work
  785. correctly (i.e., as desired) in compiled code in all Lisps. In some
  786. Lisps, the compiler treats certain symbols in the LISP package
  787. specially, ignoring the function definition. If you want to redefine a
  788. standard function try proclaiming/declaring it NOTINLINE prior to
  789. compiling any use that should go through the function cell. (Note that
  790. this is not guarranteed to work, since X3J13 has stated that it is not
  791. permitted to redefine any of the standard functions).
  792.  
  793. ----------------------------------------------------------------
  794. ;;; *EOF*
  795.  
  796.